IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/librw/RWTValHashMultiMapIterator.z/RWTValHashMultiMapIterator

Text File | 1998-10-30 | 9.1 KB | 265 lines

RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWTValHashMultiMapIterator<K,T,H,EQ> - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include<rw/tvhmmap.h>



              RWTValHashMultiMap<K,T,H,EQ> m;
          RWTValHashMultiMapIterator<K,T,H,EQ> itr(m);

SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy DDDDeeeeppppeeeennnnddddeeeennnntttt!!!!
     RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr requires the Standard C++ Library.


DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr is supplied with TTTToooooooollllssss....hhhh++++++++ 7 to provide an
     iterator interface to RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr that is backward
     compatible with the container iterators provided in TTTToooooooollllssss....hhhh++++++++ 6.x.
     Iteration over an RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaapppp is pseudorandom and dependent on the
     capacity of the underlying hash table and the hash function being used.
     The only useable relationship between consecutive elements is that
     elements which are defined to be equivalent by the equivalence object,
     EEEEQQQQ, will remain adjacent.  The current item referenced by this iterator
     is undefined after construction or after a call to rrrreeeesssseeeetttt(((()))).  The iterator
     becomes valid after being advanced with either a preincrement or
     ooooppppeeeerrrraaaattttoooorrrr(((()))).  For both ooooppppeeeerrrraaaattttoooorrrr++++++++ and ooooppppeeeerrrraaaattttoooorrrr(((()))), iterating past the last
     element will return a value equivalent to boolean ffffaaaallllsssseeee.  Continued
     increments will return a value equivalent to ffffaaaallllsssseeee until rrrreeeesssseeeetttt(((()))) is
     called.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None

EEEExxxxaaaammmmpppplllleeee
              #include<rw/tvhmmap.h>



              #include<rw/cstring.h>
          #include<iostream.h>


              struct silly_h{



                 unsigned long operator()(const RWCString& x) const
             { return x.length() * (long)x(0); }
          };





                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



              int main(){



                 RWTValHashMultiMap
               <RWCString,int,silly_h,equal_to<RWCString> > age;
             RWTValHashMultiMapIterator
               <RWCString, int, silly_h, equal_to<RWCString > > itr(age);


                 age.insert(RWCString("John"), 30);



                 age.insert(RWCString("Steve"),17);
             age.insert(RWCString("Mark"),24);
             age.insert(RWCString("Steve"),24);


                 for(;itr();)



                   cout << itr.key() << "'s age is " << itr.value() << endl;



                 return 0;



              }



              Program Output (not necessarily in this order)



              John's age is 30
          Steve's age is 24
          Steve's age is 17
          Mark's age is 24

PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
              RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr<<<<KKKK,,,,TTTT,,,,HHHH,,,,EEEEQQQQ>>>>



              (RWTValHashMultiMap<K,T,H,EQ>&h);





                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))






     Creates an iterator for the hash multimap hhhh.  The iterator begins in an
     undefined state and must be advanced before the first element will be
     accessible.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
              RWBoolean
          ooooppppeeeerrrraaaattttoooorrrr(((())))();


     Advances sssseeeellllffff to the next element, dereferences the resulting iterator
     and returns ffffaaaallllsssseeee if the iterator has advanced past the last item in the
     container and ttttrrrruuuueeee otherwise.

              RWBoolean
          ooooppppeeeerrrraaaattttoooorrrr++++++++();


     Advances sssseeeellllffff to the next element.  If the iterator has been reset or
     just created sssseeeellllffff will now reference the first element.  If, before
     iteration, sssseeeellllffff referenced the last association in the multimap, sssseeeellllffff
     will now reference an undefined value and ffffaaaallllsssseeee will be returned.
     Otherwise, ttttrrrruuuueeee is returned. Note: no postincrement operator is provided.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
              RWTValHashMultiMap<K,T,H,EQ>*
          ccccoooonnnnttttaaaaiiiinnnneeeerrrr(((()))) const;


     Returns a pointer to the collection being iterated over.

              K
          kkkkeeeeyyyy() const;


     Returns the key portion of the association currently referenced by sssseeeellllffff.

              void
          rrrreeeesssseeeetttt();
          void
          rrrreeeesssseeeetttt(RWTValHashMultiMap<K,T,H,EQ>& h);


     Resets the iterator so that after being advanced it will reference the
     first element of the collection.  Using rrrreeeesssseeeetttt(((()))) with no argument will
     reset the iterator on the current container.  Supplying a
     RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaapppp with rrrreeeesssseeeetttt(((()))) will reset the iterator on that
     container.





                                                                        PPPPaaaaggggeeee 3333






RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiMMMMaaaappppIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



              T
          vvvvaaaalllluuuueeee();


     Returns the value portion of the association referenced by sssseeeellllffff.


















































                                                                        PPPPaaaaggggeeee 4444